List of Variable Functions and Attributes
This document contains the list of variable functions and attributes. Also see:
Variable Attributes
- DIM: An array giving the dimensions (0 for scalar variables).
- LENGTH: The number of elements in the variable.
- NDIM: An integer giving the number of dimensions (0 for scalar variables).
- TNAME: A string giving the raw IDL type name.
- TYPECODE: An integer giving the IDL type code.
- TYPENAME: A string giving the IDL type name, including the structure or class name.
- TYPESIZE: An integer giving the size in bytes of a single element (always 0 for strings and structures).
IDL_Integer
- BitLength: Returns the number of bits in the current value, ignoring leading zero bits.
- BitGet: Returns the requested bit associated with the current value.
- BitSet: Returns a scalar or array of values after setting the bits on the current value.
- BitShift: Returns a scalar or array of values after shifting the bits on the current value.
- ToASCII: Converts the current number to an ASCII string.
- ToBinary: Converts the current number to a binary string.
- ToHex: Converts the current number to a hex string.
- ToOctal: Converts the current number to an octal string.
IDL_Number
- Ceil: Compute the ceiling.
- Floor: Compute the floor.
- Imaginary: Return the imaginary value.
- Mean: Compute the mean.
- Median: Compute the median.
- Max: Return the value of the largest element.
- Min: Return the value of the smallest element.
- Product: Compute the product.
- Real: Return the real value.
- Round: Round the value.
- Signum: Compute the signum.
- Total: Compute the total.
IDL_Pointer
- PtrType: Returns the variable type of the pointer's data.
- Valid: Returns the validity of its pointer arguments.
IDL_String Methods
- CapWords: Capitalize any words contained within the string.
- CharAt: Returns the character at the supplied index.
- Compress: Removes all white space.
- Contains: Returns true if the string contains a given substring.
- Decrypt: Decrypts the string using the RSA asymmetric cryptosystem.
- Dup: Duplicates a scalar string.
- Encrypt: Encrypts the string using the RSA asymmetric cryptosystem.
- EndsWith: Returns true if the string ends with the given string.
- Extract: Returns part of the string using a regular expression.
- IndexOf: Returns the index of a character or substring.
- Insert: Inserts another string.
- Join: Combines multiple strings into a single string.
- LastIndexOf: Returns the last index of a character or substring.
- Matches: Returns true if the string matches a regular expression.
- Remove: Remove part of a string.
- Replace: Replaces text within the string.
- Reverse: Reverse a string.
- Split: Split into substrings using a regular expression.
- StartsWith: Returns true if the string starts with the given string.
- Strlen: Returns the string length.
- Substring: Returns part of a string.
- ToByte: Converts to a byte array.
- ToLower: Convert all characters to lowercase.
- ToUpper: Convert all characters to uppercase.
- Trim: Removes leading and trailing white space.
IDL_Variable
- Compare: Compare to another variable and return –1, 0, or 1 for each value.
- Convert: Convert the variable to a different data type.
- Diff: Returns the unique elements that have been added to or removed from a variable.
- Dup: Duplicate a scalar value into an array.
- Equals: Tests whether two variables are equal.
- Filter: Returns only data values that successfully pass through a user-defined filter or Lambda function.
- Finite: Returns only the finite values within an array.
- FromBits: Converts the variable from an array of bits.
- Hashcode: Returns a hash code for the variable.
- HasValue: Returns 1 (true) if the variable contains a given set of values.
- IsFinite: Returns 1 (true) if all of the values in the variable are finite.
- IsInfinite: Returns 1 (true) if all of the values in the variable are infinite.
- IsNaN: Returns 1 (true) if all of the values in the variable are NaN.
- IsReal: Returns 1 (true) if the variable is not a complex data type.
- Map: Pass all data values through a user-defined function or Lambda function.
- NestedMap: Use a nested loop to pass the data values and arguments through a user function.
- PtrValid: Returns the validity of its pointer arguments, or alternatively returns a vector of pointers to all the existing valid pointer heap variables.
- Reduce: Use a user-defined function or Lambda function to cumulatively combine all values from left to right and return a single value.
- Reform: Change the array dimensions.
- Shift: Shift array elements along a dimension.
- Sort: Returns a sorted copy of the array.
- ToBits: Converts the variable to an array of bits.
- ToDouble: Converts the variable to type DOUBLE.
- ToInteger: Converts the variable to type LONG.
- ToList: Converts the variable to a LIST.
- ToString: Converts the variable to type STRING.
- Uniq: Returns a sorted copy of the array with all duplicates removed.